/**
 * Collaborative Story Development Web Application (CSDApp) 
 * Copyright Anton Strack 2014
 *
 * This file is part of Collaborative Story Development Application (CSDApp).
 *
 * CSDApp is free software: you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or any later version.
 *
 * CSDApp is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * CSDApp. If not, see <http://www.gnu.org/licenses/>.
 *
 */
package csdwa;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * This class provides database access to the specific resource model. It
 * provides CRUD database functionality and it stores it's results as a list.
 * Additionally, through it's methods, it provides access to determine the table
 * name, and query markers that are set for the particular DAO and thus allows
 * other code a means of interacting with this DAO to execute more advanced
 * queries.
 *
 * @author Anton Strack
 */
public class UserHistoryDao extends DaoSupport implements CsdwaDao<UserHistory> {

    private List<UserHistory> beans;

    public UserHistoryDao(Connection conn) {
        super(conn);
        this.beans = new ArrayList<UserHistory>();
        this.restoreQueryMarkers();
    }

    /**
     * Select all the beans from the bean table
     *
     * @return the row count indicating if 0 or more beans were retrieved from
     * the database.
     */
    @Override
    public int selectBeans() {
        int result = 0;
        this.usingQueryMarkers = this.getCoreSelectUsingQueryMarkers();
        this.setMarker(QueryMarker.CORE_CONDITIONS, "1=1");
        try {
            ps = getConn().prepareStatement(this.buildQueryString(this.usingQueryMarkers, SELECT_QUERY));
            result = executeSelectQuery(ps);
        } catch (SQLException ex) {
            Logger.getLogger(PostDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Select a single bean by it's id.
     *
     * @param id the id number of the bean to select.
     * @return 1 or 0, indicating a bean was retrieved or not.
     */
    @Override
    public int selectBeanById(int id) {
        int result = 0;
        this.usingQueryMarkers = this.getCoreSelectUsingQueryMarkers();
        this.setMarker(QueryMarker.CORE_CONDITIONS, "posthistory.ID = ?");
        try {
            ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, SELECT_QUERY));
            this.ps.setInt(1, id);
            result = executeSelectQuery(ps);
        } catch (SQLException ex) {
            Logger.getLogger(PostDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Select a a list of post histories for a user performing a specific action
     * on a specific type of posts.
     *
     * @param userId the id of the user who's history to check
     * @param actionTypeId the type of action to filter the history check by.
     * @param postResouceTypeId the type of resource to check the user's history
     * with.
     * @return the number of beans retrieved or 0 if no beans were retrieved
     */
    public int selectUserPostHistories(int userId, int actionTypeId, int postResouceTypeId) {
        int result = 0;
        this.usingQueryMarkers = this.getCoreSelectUsingQueryMarkers();
        this.setMarker(QueryMarker.CORE_CONDITIONS, "posthistory.PostResourceTypeID = ? AND posthistory.ActionTypeID = ? AND posthistory.UserID = ?");
        try {
            ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, SELECT_QUERY));
            this.ps.setInt(1, postResouceTypeId);
            this.ps.setInt(2, actionTypeId);
            this.ps.setInt(3, userId);
            result = executeSelectQuery(ps);
        } catch (SQLException ex) {
            Logger.getLogger(PostDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Select a a list of post histories for a user on a specific type of posts.
     *
     * @param userId the id of the user who's history to check
     * @param postResouceTypeId the type of resource to check the user's history
     * with.
     * @return the number of beans retrieved or 0 if no beans were retrieved
     */
    public int selectUserPostHistories(int userId, int postResouceTypeId) {
        int result = 0;
        this.usingQueryMarkers = this.getCoreSelectUsingQueryMarkers();
        this.setMarker(QueryMarker.CORE_CONDITIONS, "posthistory.PostResourceTypeID = ? AND posthistory.UserID = ?");
        try {
            ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, SELECT_QUERY));
            this.ps.setInt(1, postResouceTypeId);
            this.ps.setInt(2, userId);
            result = executeSelectQuery(ps);
        } catch (SQLException ex) {
            Logger.getLogger(PostDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Select a a list of post histories for a user
     *
     * @param userId the id of the user who's history to check
     * @return
     * @return the number of beans retrieved or 0 if no beans were retrieved
     */
    public int selectUserPostHistories(int userId) {
        int result = 0;
        this.usingQueryMarkers = this.getCoreSelectUsingQueryMarkers();
        this.setMarker(QueryMarker.CORE_CONDITIONS, "posthistory.UserID = ?");
        try {
            ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, SELECT_QUERY));
            this.ps.setInt(1, userId);
            result = executeSelectQuery(ps);
        } catch (SQLException ex) {
            Logger.getLogger(PostDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    public int selectUserPostHistory(int userId, int actionTypeId, int postResourceId, int postId) {
        int result = 0;
        this.usingQueryMarkers = this.getCoreSelectUsingQueryMarkers();
        this.setMarker(QueryMarker.CORE_CONDITIONS, "posthistory.PostResourceTypeID = ? AND posthistory.ActionTypeID = ? AND posthistory.UserID = ? AND posthistory.PostID = ?");
        try {
            ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, SELECT_QUERY));
            this.ps.setInt(1, postResourceId);
            this.ps.setInt(2, actionTypeId);
            this.ps.setInt(3, userId);
            this.ps.setInt(4, postId);
            result = executeSelectQuery(ps);
        } catch (SQLException ex) {
            Logger.getLogger(PostDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Clear the bean list so it doesn't contain any beans.
     */
    @Override
    public void clearDaoBeans() {
        this.beans.clear();
    }

    /**
     * Get the bean stored in the dao by it's primary id.
     *
     * @param id the id of the bean to select.
     * @return the bean if it exists in the dao or null if it doesn't
     */
    @Override
    public UserHistory getBeanById(int id) {
        UserHistory bean = null;
        if (this.beans.isEmpty() == false) {
            for (UserHistory b : this.beans) {
                if (b.getId() == id) {
                    bean = b;
                    break;
                }
            }
        }
        return bean;
    }

    /**
     * Save a bean to the database
     *
     * @param bean the bean to insert. The bean id is not required and won't be
     * used. All other bean values are required.
     * @return the auto-generated id key for the new bean row or 0 on failure.
     */
    @Override
    public int insertBean(UserHistory bean) {
        int result = 0;
        ResultSet rs;
        this.usingQueryMarkers = new ArrayList<QueryMarker>();
        this.usingQueryMarkers.add(QueryMarker.CORE_COLUMNS);
        this.usingQueryMarkers.add(QueryMarker.CORE_TABLE);
        this.usingQueryMarkers.add(QueryMarker.INSERT_VALUES);
        /*
         * HSQLDB cannot properly handle insert statements that have table identifiesr in the form of table.columnName so we need to remove the table name for inserts.
         */
        this.queryMarkers.put(QueryMarker.CORE_COLUMNS, this.prepareInsertColumns(this.getMarker(QueryMarker.CORE_COLUMNS)));
        try {
            this.ps = this.getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, INSERT_QUERY), Statement.RETURN_GENERATED_KEYS);
            this.ps.setNull(1, java.sql.Types.NULL);
            this.ps.setInt(2, bean.getPostId());
            this.ps.setInt(3, bean.getPostStateId());
            this.ps.setInt(4, bean.getPostResourceTypeId());
            this.ps.setInt(5, bean.getActionTypeId());
            this.ps.setInt(6, bean.getUserId());
            this.ps.setInt(7, bean.getResourceTypeId());
            this.ps.setString(8, bean.getPostName());
            this.ps.setString(9, bean.getUserName());
            this.ps.setTimestamp(10, bean.getHistoryDate());
            result = this.ps.executeUpdate();
            rs = ps.getGeneratedKeys();
            if (result != 0 && rs.next()) {
                result = rs.getInt(1); // get the auto-generated key from the successful insert operation.
            }
        } catch (SQLException ex) {
            Logger.getLogger(PlotDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Update a bean in the database as well as the bean in the dao's beans map.
     *
     * @param bean the bean to update.
     * @return 1 or 0 indicating if the bean was updated or not.
     */
    @Override
    public int updateBean(UserHistory bean) {
        int result = 0;

        this.usingQueryMarkers = new ArrayList<QueryMarker>();
        this.usingQueryMarkers.add(QueryMarker.CORE_CONDITIONS);
        this.usingQueryMarkers.add(QueryMarker.CORE_TABLE);
        this.usingQueryMarkers.add(QueryMarker.UPDATE_COLUMNS_VALUES);

        String[] cols = this.splitStringByCommas(this.COLUMNS_TO_UPDATE);

        this.setMarker(QueryMarker.UPDATE_COLUMNS_VALUES, this.prepareUpdateColumns(cols));
        this.setMarker(QueryMarker.CORE_CONDITIONS, "ID = ?");

        try {
            this.ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, UPDATE_QUERY));
            int index = 1;
            for (String col : cols) {
                if ("PostName".equalsIgnoreCase(col)) {
                    this.ps.setString(index, bean.getPostName());
                    index++;
                } else if ("UserName".equalsIgnoreCase(col)) {
                    this.ps.setString(index, bean.getUserName());
                    index++;
                } else if ("PostID".equalsIgnoreCase(col)) {
                    this.ps.setInt(index, bean.getPostId());
                    index++;
                } else if ("PostStateID".equalsIgnoreCase(col)) {
                    this.ps.setInt(index, bean.getPostStateId());
                    index++;
                } else if ("PostResourceTypeID".equalsIgnoreCase(col)) {
                    this.ps.setInt(index, bean.getPostResourceTypeId());
                    index++;
                } else if ("ActionTypeID".equalsIgnoreCase(col)) {
                    this.ps.setInt(index, bean.getActionTypeId());
                    index++;
                } else if ("ResourceTypeId".equalsIgnoreCase(col)) {
                    this.ps.setInt(index, bean.getResourceTypeId());
                    index++;
                } else if ("HistoryDate".equalsIgnoreCase(col)) {
                    this.ps.setTimestamp(index, bean.getHistoryDate());
                    index++;
                }
            }
            this.ps.setInt(index, bean.getId()); // where column condition
            result = this.ps.executeUpdate();
        } catch (SQLException ex) {
            Logger.getLogger(ResourceTypeDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Deletes the bean from the database
     *
     * @param bean the bean to delete
     * @return 1 or 0 indicating if the bean was deleted or not.
     */
    @Override
    public int deleteBean(UserHistory bean) {
        int result = 0;
        this.usingQueryMarkers = new ArrayList<QueryMarker>();
        this.usingQueryMarkers.add(QueryMarker.CORE_CONDITIONS);
        this.usingQueryMarkers.add(QueryMarker.CORE_TABLE);
        this.setMarker(QueryMarker.CORE_CONDITIONS, "ID = ?");
        try {
            ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, DELETE_QUERY));
            this.ps.setInt(1, bean.getId());
            result = this.ps.executeUpdate();
        } catch (SQLException ex) {
            Logger.getLogger(PlotDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Reset the query markers to their default values for the dao.
     */
    @Override
    public void restoreQueryMarkers() {
        this.setMarker(QueryMarker.CORE_TABLE, "posthistory");
        this.setMarker(QueryMarker.CORE_COLUMNS, "posthistory.ID, posthistory.PostID, posthistory.PostStateID, posthistory.PostResourceTypeId, posthistory.ActionTypeID, posthistory.UserID, posthistory.ResourceTypeID, posthistory.PostName, posthistory.UserName, posthistory.HistoryDate");
        this.setMarker(QueryMarker.CORE_CONDITIONS, "posthistory.ID = ?");
        this.setMarker(QueryMarker.ORDER_BY_COLUMN, "posthistory.HistoryDate");
        this.setMarker(QueryMarker.ORDER_BY_MODE, "DESC");
        this.setMarker(QueryMarker.LIMIT, "");
        this.setMarker(QueryMarker.INSERT_VALUES, "?, ?, ?, ?, ?, ?, ?, ?, ?, ?");
        this.setMarker(QueryMarker.UPDATE_COLUMNS_VALUES, "");
        this.setMarker(QueryMarker.PRIMARY_KEY, "ID");
        // special type of derived values
        this.setMarker(QueryMarker.RELATED_COLUMNS, ", state.name AS PostStateName, resourcetype.name AS PostResourceTypeName, actiontype.name AS ActionTypeName");
        this.setMarker(QueryMarker.RELATED_CONDITIONS, " AND posthistory.PostResourceTypeId = resourcetype.ID AND posthistory.ActionTypeID = actiontype.ID AND posthistory.PostStateID = state.ID");
        this.setMarker(QueryMarker.RELATED_TABLES, ", actiontype, state, resourcetype");
        this.COLUMNS_TO_UPDATE = "PostStateID, HistoryDate";
    }

    /**
     * Execute the select query and place the results in beans list.
     *
     * @param ps the fully prepared PreparedStatement
     * @return the row count from the select statement
     */
    @Override
    protected int executeSelectQuery(PreparedStatement ps) {
        int result = 0;
        ResultSet rs;
        try {
            rs = ps.executeQuery();
            while (rs.next()) {
                UserHistory bean = ResourceFactory.makePostHistory();
                bean.setId(rs.getInt("posthistory.ID"));
                bean.setPostId(rs.getInt("posthistory.PostID"));
                bean.setPostStateId(rs.getInt("posthistory.PostStateID"));
                bean.setPostResourceTypeId(rs.getInt("posthistory.PostResourceTypeID"));
                bean.setActionTypeId(rs.getInt("posthistory.ActionTypeID"));
                bean.setResourceTypeId(rs.getInt("posthistory.UserID"));
                bean.setResourceTypeId(rs.getInt("posthistory.ResourceTypeID"));
                bean.setHistoryDate(rs.getTimestamp("posthistory.HistoryDate"));
                bean.setUserName(rs.getString("posthistory.UserName"));
                bean.setPostName(rs.getString("posthistory.PostName"));
                if (this.USE_RELATED_MARKERS == true) {
                    bean.setDerivedValue("PostStateName", rs.getString("PostStateName"));
                    bean.setDerivedValue("PostResourceTypeName", rs.getString("PostResourceTypeName"));
                    bean.setDerivedValue("ActionTypeName", rs.getString("ActionTypeName"));
                }
                this.processDerivedValues(bean, rs);
                this.beans.add(bean);
                result++;
            }
        } catch (SQLException ex) {
            Logger.getLogger(ActionDao.class.getName()).log(Level.SEVERE, null, ex);
        }


        return result;
    }

    /**
     * Get a list of beans
     *
     * @return a list of bean objects
     */
    @Override
    public List<UserHistory> getBeans() {
        return new ArrayList<UserHistory>(this.beans);
    }

    /**
     * Get a single bean.
     *
     * @return a single bean in the bean dao.
     */
    @Override
    public UserHistory getBean() {
        if (this.beans.isEmpty()) {
            return null;
        }
        return this.beans.get(0);
    }

    /**
     * Add a bean in the dao's bean list.
     *
     * @param bean the bean to add or update
     */
    @Override
    public void addBeanToDao(UserHistory bean) {
        this.beans.add(bean);
    }

    /**
     * This method extracts the derived values from the result set as indicated
     * by the derived columns query marker. This method then adds the values to
     * the bean's derived value map using the column name as the key.
     *
     * @param bean the bean being processed in the select query
     * @param rs the result set from the select query
     */
    public void processDerivedValues(UserHistory bean, ResultSet rs) {
        if (this.getMarker(QueryMarker.DERIVED_COLUMNS).length() > 0) {

            String[] cols = this.splitStringByCommas(this.getMarker(QueryMarker.DERIVED_COLUMNS));
            for (String column : cols) {
                try {
                    bean.setDerivedValue(column, rs.getString(column));
                } catch (SQLException ex) {
                    Logger.getLogger(DaoSupport.class.getName()).log(Level.SEVERE, null, ex);
                    ex.printStackTrace();
                } catch (Exception ex) {
                    Logger.getLogger(DaoSupport.class.getName()).log(Level.SEVERE, null, ex);
                    ex.printStackTrace();
                }
            }
        }
    }
}
